home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-11 / shelp50a.zip / HINTS.TXT < prev    next >
Text File  |  1991-07-05  |  4KB  |  85 lines
  1.  
  2.                           *  Superhelp Hints  *
  3.  
  4. Before you make your first help window, be sure to setup the Project 
  5. Information.  Only windows setup with the proper Project Information will 
  6. be generated.  Please glance through the SUPERHELP NEWS letter before 
  7. starting.  Also, you may generate a Users Guide from the demo.  It will 
  8. contain alot of information about SUPERHELP although it will not be complete.
  9.  
  10. For the best help system, generate code using the Reference file.  By 
  11. using the REFERENCE file, SUPERHELP supports all the special effects and 
  12. features.  The inline generation of code should only be used on very small 
  13. help systems. 
  14.  
  15. The Reference File method provides the best performance and security.  
  16. The help can not be modified without being detected.  Also there are no 
  17. indexes to add overhead.  The Reference File adds the fastest access of all 
  18. other methods.
  19.  
  20. Please try the other generating features.  Generating the Data Dictionary 
  21. is very helpful when keeping up with help window attributes.  The Data 
  22. Dictionary can be generated with full help text or in summary format.  
  23. By generating the Users Guide, you will have a ready made manual with a 
  24. table of contents.  Also a system overview may be included with the Users 
  25. Guide by setting up the name in the Project Setup. 
  26.  
  27. A new function is included in the Superhelp Library called ENKEY().  
  28. ENKEY() replaces Clipper's INKEY() function where help code is needed.  
  29. The syntax for the ENKEY() function follows:
  30.  
  31.   ENKEY(time,PROCNAME(),0,variable)
  32.   Example: ENKEY(30,PROCNAME(),0,"INKEY1")
  33.  
  34. The above waits 30 seconds, passing the current procedure name and the 
  35. variable named "INKEY1" to the SUPERHELP system.
  36.  
  37.  
  38.  
  39.  
  40.                                    *  Important *
  41.  
  42. The main help system function is called SUPERBUILD.  SUPERBUILD creates all 
  43. help windows and allows the developer to generate the help windows.  But 
  44. SUPERBUILD has a high memory overhead when building the help system.  There 
  45. are two other functions called MINIBUILD and CODEBUILD.  MINIBUILD only 
  46. allows the developer to create the help windows.  CODEBUILD only allows 
  47. the developer to generate the help windows.  With these two functions the 
  48. OVERHEAD of SUPERHELP is cut in half.
  49.  
  50. The overhead of SUPERHELP after generating the Help System is only around 10k.
  51.  
  52. These 3 functions must be declared external in your application.  Only link in one of the functions at a time.
  53.  
  54. EXTERNAL SUPERBUILD - About 110k overhead.
  55. EXTERNAL MINIBUILD - About 65k overhead.
  56. EXTERNAL CODEBUILD - About 45k overhead.
  57.  
  58. The entire SUPERHELP LIBRARY and GENERATED CODE can be dynamically 
  59. overlayed!!!  So the overhead is really just in program size.  When finished 
  60. generating code, remove the call to the SUPERHELP functions.
  61.  
  62.  
  63.                          * Mono System Developers * 
  64.  
  65. SUPERHELP has been enhanced to support developers with mono system.  When 
  66. selecting colors, the Clipper color code will be display on the header 
  67. line of the Color Window.  The DOS environmental variable SUPERCLR must be 
  68. set to MONO for a MONO menu system.  Example :  Set SUPERCLR=MONO
  69.  
  70.  
  71.  
  72.  
  73.  
  74. *  Disclaimer  *
  75.  
  76. Darryl Strickland or DJS Applications can not be held responsible for any 
  77. damages caused by the used of SUPERHELP LIBRARY.  The library has been 
  78. tested for 1.5 years on live system and have not caused any damages to 
  79. any of the system.  The user must determine if SUPERHELP meets the needs of 
  80. the user.
  81.  
  82.  
  83.  
  84.  
  85.